home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / awf / awf.1.out < prev    next >
Encoding:
Text File  |  1995-05-16  |  6.5 KB  |  199 lines
  1.  
  2.  
  3. AWF(1)                     Unix Programmer's Manual                     AWF(1)
  4.  
  5.  
  6. NNNAAAMMMEEE
  7.      awf - amazingly workable (text) formatter
  8.  
  9. SSSYYYNNNOOOPPPSSSIIISSS
  10.      aaawwwfff -mmm_a_c_r_o_s [ file ] ...
  11.  
  12. DDDEEESSSCCCRRRIIIPPPTTTIIIOOONNN
  13.      _A_w_f formats the text from the input _f_i_l_e(s) (standard input if  none)  in
  14.      an  imitation  of _n_r_o_f_f's style with the -mmmaaannn or -mmmsss macro packages.  The
  15.      -mmm_a_c_r_o option is mandatory and must be `-man' or `-ms'.
  16.  
  17.      _A_w_f implements the following raw _n_r_o_f_f requests:
  18.  
  19.             .\"    .ce     .fi     .in     .ne     .pl     .sp
  20.             .ad     .de     .ft     .it     .nf     .po     .ta
  21.             .bp     .ds     .ie     .ll     .nr     .ps     .ti
  22.             .br     .el     .if     .na     .ns     .rs     .tm
  23.  
  24.      and the following in-text codes:
  25.  
  26.           \$    \%     \*     \c     \f     \n     \s
  27.  
  28.      plus the full list of _n_r_o_f_f/_t_r_o_f_f special characters in the  original  V7
  29.      _t_r_o_f_f manual.
  30.  
  31.      Many restrictions are present; the behavior in general  is  a  subset  of
  32.      _n_r_o_f_f's.  Of particular note are the following:
  33.  
  34.      +o Point sizes do not exist; ...pppsss and \sss are ignored.
  35.  
  36.      +o Conditionals implement only numeric comparisons on \nnn(((...$$$,  string  com-
  37.        parisons  between  a macro parameter and a literal, and nnn (always true)
  38.        and ttt (always false).
  39.  
  40.      +o The implementation of strings is generally primitive.
  41.  
  42.      +o Expressions in (e.g.) ...sssppp are fairly general,  but  the  |||,  &&&,  and  :::
  43.        operators  do  not  exist,  and  the implementation of \www requires that
  44.        quote (') be used as the delimiter and  simply  counts  the  characters
  45.        inside (so that, e.g., \w'\(bu' equals 4).
  46.  
  47.      White space at the beginning of lines, and imbedded  white  space  within
  48.      lines, is dealt with properly.  Sentence terminators at ends of lines are
  49.      understood to imply extra space afterward in filled lines.  Tabs are  im-
  50.      plemented  crudely  and  not quite correctly, although in most cases they
  51.      work as expected.  Hyphenation is done  only  at  explicit  hyphens,  em-
  52.      dashes, and _n_r_o_f_f discretionary hyphens.
  53.  
  54. MMMAAANNN MMMAAACCCRRROOOSSS
  55.      The -mmmaaannn macro set implements the full V7 manual macros, plus a few semi-
  56.      random oddballs.  The full list is:
  57.  
  58.           .B   .DT     .IP     .P      .RE     .SM
  59.           .BI  .HP     .IR     .PD     .RI     .TH
  60.           .BR  .I      .LP     .PP     .RS     .TP
  61.           .BY  .IB     .NB     .RB     .SH     .UC
  62.  
  63.  
  64. U of Toronto                          13 July 1990                           1
  65.  
  66.  
  67.  
  68.  
  69. AWF(1)                     Unix Programmer's Manual                     AWF(1)
  70.  
  71.  
  72.      ...BBBYYY and ...NNNBBB each take a single string argument  (respectively,  an  indi-
  73.      cation  of authorship and a note about the status of the manual page) and
  74.      arrange to place it in the page footer.
  75.  
  76. MMMSSS MMMAAACCCRRROOOSSS
  77.      The -mmmsss macro set is a substantial subset of the  V7  manuscript  macros.
  78.      The implemented macros are:
  79.  
  80.           .AB  .CD     .ID     .ND     .QP     .RS     .UL
  81.           .AE  .DA     .IP     .NH     .QS     .SH     .UX
  82.           .AI  .DE     .LD     .NL     .R      .SM
  83.           .AU  .DS     .LG     .PP     .RE     .TL
  84.           .B   .I      .LP     .QE     .RP     .TP
  85.  
  86.      Size changes are recognized but ignored, as are ...RRRPPP and  ...NNNDDD.   ...UUULLL  just
  87.      prints  its  argument in italics.  ...DDDSSS/...DDDEEE does not do a keep, nor do any
  88.      of the other macros that normally imply keeps.
  89.  
  90.      Assignments to the header/footer  string  variables  are  recognized  and
  91.      implemented,  but  there  is  otherwise  no  control  over  header/footer
  92.      formatting.  The DDDYYY string variable is available.  The  PPPDDD,  PPPIII,  and  LLLLLL
  93.      number registers exist and can be changed.
  94.  
  95. OOOUUUTTTPPPUUUTTT
  96.      The only output format supported by _a_w_f, in its distributed form, is that
  97.      appropriate  to  a  dumb  terminal,  using  overprinting for italics (via
  98.      underlining) and bold.  The _n_r_o_f_f special characters are printed as  some
  99.      vague   approximation  (it's  sometimes  very  vague)  to  their  correct
  100.      appearance.
  101.  
  102.      _A_w_f's knowledge of the output device is established  by  a  device  file,
  103.      which  is  read  before  the user's input.  It is sought in _a_w_f's library
  104.      directory, first as dddeeevvv..._t_e_r_m  (where  _t_e_r_m  is  the  value  of  the  TERM
  105.      environment  variable)  and,  failing that, as dddeeevvv...ddduuummmbbb.  The device file
  106.      uses special internal commands to set up resolution, special  characters,
  107.      fonts, etc., and more normal _n_r_o_f_f commands to set up page length etc.
  108.  
  109. FFFIIILLLEEESSS
  110.      All  in  /_u_s_r/_s_k_u_n_k/_l_i_b/_a_w_f  (this  can  be  overridden  by  the   AWFLIB
  111.      environment variable):
  112.  
  113.      common common device-independent initialization
  114.      dev.*  device-specific initialization
  115.      mac.m* macro packages
  116.      pass1  macro substituter
  117.      pass2.base     central formatter
  118.      pass2.m*       macro-package-specific bits of formatter
  119.      pass3  line and page composer
  120.  
  121. SSSEEEEEE AAALLLSSSOOO
  122.      awk(1), nroff(1), man(7), ms(7)
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130. U of Toronto                          13 July 1990                           2
  131.  
  132.  
  133.  
  134.  
  135. AWF(1)                     Unix Programmer's Manual                     AWF(1)
  136.  
  137.  
  138. DDDIIIAAAGGGNNNOOOSSSTTTIIICCCSSS
  139.      Unlike _n_r_o_f_f, _a_w_f complains whenever it sees unknown commands and macros.
  140.      All diagnostics (these and some internal ones) appear on standard error
  141.      at the end of the run.
  142.  
  143. HHHIIISSSTTTOOORRRYYY
  144.      Written at University of Toronto by Henry Spencer,  more  or  less  as  a
  145.      supplement to the C News project.
  146.  
  147.                      => None of the above really want to admit it. =<
  148.  
  149. BBBUUUGGGSSS
  150.      There are plenty, but what do you expect for  a  text  formatter  written
  151.      entirely in (old) _a_w_k?
  152.  
  153.      The -mmmsss stuff has not been checked out very thoroughly.
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. U of Toronto                          13 July 1990                           3
  197.  
  198.  
  199.